@egjs/component
Advanced tools
@egjs/component is a simple and lightweight JavaScript library for creating and managing custom events. It allows developers to create components that can emit and listen to events, making it easier to build interactive and modular applications.
Creating a Component
This code demonstrates how to create a new component by extending the Component class from @egjs/component. The new component can then be instantiated and used in your application.
const Component = require('@egjs/component');
class MyComponent extends Component {
constructor() {
super();
}
}
const myComponent = new MyComponent();Emitting Events
This code demonstrates how to emit custom events from a component. The `doSomething` method triggers an event called 'somethingHappened' with some data. The event listener logs the data to the console when the event is triggered.
const Component = require('@egjs/component');
class MyComponent extends Component {
constructor() {
super();
}
doSomething() {
this.trigger('somethingHappened', { data: 'example data' });
}
}
const myComponent = new MyComponent();
myComponent.on('somethingHappened', (event) => {
console.log(event.data); // Output: example data
});
myComponent.doSomething();Listening to Events
This code demonstrates how to listen to custom events in a component. The `on` method is used to register an event listener for 'customEvent'. When the event is triggered, the listener logs the event data to the console.
const Component = require('@egjs/component');
class MyComponent extends Component {
constructor() {
super();
}
}
const myComponent = new MyComponent();
myComponent.on('customEvent', (event) => {
console.log('Custom event received:', event);
});
myComponent.trigger('customEvent', { message: 'Hello, world!' });EventEmitter3 is a high-performance event emitter for Node.js and the browser. It provides a similar functionality to @egjs/component by allowing developers to create and manage custom events. However, EventEmitter3 is more focused on performance and is widely used in various projects.
Mitt is a tiny (~200 bytes) functional event emitter. It provides a simple and minimalistic API for creating and managing custom events. Mitt is similar to @egjs/component in terms of functionality but is much smaller in size and has no dependencies.
EventEmitter2 is an implementation of the EventEmitter found in Node.js. It extends the original EventEmitter with additional features like wildcard event names and event namespacing. EventEmitter2 offers more advanced features compared to @egjs/component, making it suitable for more complex event handling scenarios.
A class used to manage events and options in a component
Download dist files from repo directly or install it via npm.
You can download the uncompressed files for development
You can download the compressed files for production
The following command shows how to install egjs-component using npm.
$ npm install @egjs/component
The following are the supported browsers.
| Internet Explorer | Chrome | Firefox | Safari | iOS | Android |
|---|---|---|---|---|---|
| 7+ | Latest | Latest | Latest | 7+ | 2.1+(except 3.x) |
<script src="../dist/component.js"></script>
class Some extends eg.Component {
hi() {
alert("hi");
}
thing() {
this.once("hi", this.hi);
}
}
var some = new Some();
some.thing();
some.trigger("hi");
// fire alert("hi");
some.trigger("hi");
// Nothing happens
You can use Typescript Generics to define events that component can emit.
import Component from "@egjs/component";
type ComponentEvent = {
event1: {
prop1: number;
prop2: string;
};
// You can also define like this if there're more than one arguments for a event
// First argument should be object type
event2: (arg0: {
prop1: number;
prop2: string;
}, arg1: string, arg2: boolean) => void;
// If there're no event props
event3: void;
}
// tslint:disable-next-line max-classes-per-file
class SomeClass extends Component<ComponentEvent> {
thing() {
this.on("event1", e => {
// These properties will be available for typescript-enabled environment
e.prop1; // number
e.prop2; // string
e.currentTarget; // SomeClass
e.eventType; // string("event1")
e.stop; // () => void
});
}
}
If you find a bug, please report it to us using the Issues page on GitHub.
eg.Component is released under the MIT license.
Copyright (c) 2015 NAVER Corp.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
FAQs
A base class utility that manages events and options in modules.
The npm package @egjs/component receives a total of 100,023 weekly downloads. As such, @egjs/component popularity was classified as popular.
We found that @egjs/component demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 10 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.
Security News
Research
Socket researchers found a malicious Maven package impersonating the legitimate ‘XZ for Java’ library, introducing a backdoor for remote code execution.